Qpid Java Broker Run Scripts

The following scripts are used to run the Qpid broker:

qpid-server
qpid-server.bat
qpid-run

These scripts are described in more detail below.

qpid-server

Overview

This script starts the Qpid Java Broker on Linux/Solaris/Cygwin platforms.

It is extremely simple, delegating the real work to the qpid-run script.

In fact, all it really provides is the main class to execute and passes through any command line arguments to qpid-run i.e.

. qpid-run org.apache.qpid.server.Main "$@"

qpid-server.bat

Overview

This script starts the Qpid Java Broker on Windows platforms. It provides a limited version of the qpid-run functionality, though is not nearly as sophisticated i.e. does not support run arguments or the full set of argument variables.

However, it does support the following features:

validates that JAVA_HOME is set
validates that QPID_HOME is set
passes any command line arguments to the main broker class
supports the use of QPID_OPTS to pass through java system properties

Note that a JIRA exists for enhancing the features this script supports http://issues.apache.org/jira/browse/QPID-168

qpid-run

Overview

The qpid-run script allows the calling program to run any given command, and provides a flexible surround supporting configurable runtime arguments for the script itself, the broker and java arguments.

Environment Variables and Defaulting

The variables noted below are used by the qpid-run script. Any default value used if not

specified is noted below.

Variable	Description	Default
QPID_HOME	Used as root for installed application path. Mandatory that users set this	None
QPID_WORK	Used as root for any working directories to which the Qpid broker writes, for logging and bdb etc	Current User's Homedir
AMQJ_LOGGING_LEVEL	Logging level for broker code	info
QPID_LOG_PREFIX	Used as a prefix for qpid broker log, see FAQ for more details	None
QPID_LOG_SUFFIX	Used as a suffix for qpid broker log, see FAQ for more details	None
JPDA_OPTS	If set and -run:jpda argument provided used for debugging props, see below	None
QPID_OPTS	Use to pass custom system properties, including management console connection info	None
JAVA_OPTS	Use to pass custom Java options, for example gc options etc	None

Run Arguments

You can provide run arguments to the qpid-run script using the syntax

-run:argument

The table below provides details of the available arguments.

Argument	Description
debug	Prints classpath and command before running it
jpda	Adds remote debugging info using JPDA_OPTS. Use JPDA_TRANSPORT and JPDA_ADDRESS to customize, JPDA_OPTS to override
external-classpath	Valid values are: ignore, first, last and only. See below for more info
print-classpath	Prints classpath before running command
help	Prints Usage information

Document generated by Confluence on Apr 22, 2008 02:47